home *** CD-ROM | disk | FTP | other *** search
/ 3D GFX / 3D GFX.iso / amiutils / u_z / worm / worm.guide (.txt) < prev    next >
Amigaguide Document  |  1995-12-30  |  10KB  |  197 lines
  1. @database Worm.guide
  2. @node Main "Worm"
  3. Worm - a Public-screen "Worm" drawing tool based on the SUN-Unix original 
  4. Version 1.1a 
  5. Author: Tim Kreuzer (and the KreuzerSoft support team)
  6. Original Amiga port: Chuck McManis
  7. Original Author (SUN-Unix): Brad Taylor
  8. This version: Copyright 
  9. 1994 by Timothy B. Kreuzer.  All rights reserved
  10. Language: SAC/C V6.5
  11.       @{"Features" link features}
  12.       @{"Limitations" link limitations}
  13.       @{"Release Notes" link releasenotes}
  14.       @{"Why did I create Worm?" link why}
  15.       @{"Getting started with Worm" link gettingstarted}
  16.       @{"Explanation of the Worm menus" link explanation}
  17.       @{"Icon Tooltypes" link icon}
  18.       @{"Credits" link credits}
  19.       @{"Contacting the Author" link contactingtheauthor}
  20.       @{"Legal Stuff" link legalstuff}
  21.       @{"KreuzerSoft Products" link kreuzersoftproducts}
  22. @endnode
  23. @node features "Features"
  24.       - Opens on the default public screen (initially the Workbench)
  25.       - Uses existing public screen palette
  26.       - Resizable display window
  27.       - Intuition menu interface w/keyboard shortcuts
  28.       - Worm speed/length/number controls
  29.       - Supports icon tooltypes for window position and size
  30.       - Tested OK using the Enforcer
  31. @endnode
  32. @node limitations "Limitations"
  33.       - Can only be used from thw Workbench (start via Icon)
  34.       - Requires a 68020+ CPU
  35.       - Requires AmigaDOS 3.0(+)
  36.       - Requires "# of screen colors" of 4 or greater
  37. @endnode
  38. @node releasenotes "Release Notes"
  39. ------------------
  40. Version 1.1a Notes
  41. -----------------
  42. Changed menus to the "Newlook menus" used in AmigaDOS 3.0+
  43. Added "About" requester and menu option
  44. Max size of the Worm window now equal to the screen size
  45. ------------------
  46. Version 1.1 Notes
  47. -----------------
  48. This version of Worm offers no new "apparent" functionality, but does
  49. incorporate a major revision of the user interface
  50. After playing around with Worm for a while, I realized that I didn't like
  51. having all the "adjustment gadgets" on the Worm window.  After you found
  52. the settings you liked, you still had these control gadgets staring you in
  53. the face.  Therefore, I changed all the control functions from being gadget-
  54. based to being menu-based
  55. I also wanted to get away from a "fixed" window size.  Moving to a menu-
  56. driven user interface has allowed this enhancement to occur as well
  57. In order to keep the menu sizes under control, this version limits the
  58. total number of worms and their lengths to 20 (down from 99 in the previous
  59. version).  I hope that this is a reasonable compromise for everyone
  60. ------------------
  61. Version 1.0 Notes
  62. -----------------
  63. Initial release
  64. @endnode
  65. @node why "Why did I create Worm?"
  66. I have been lucky to work as a C programmer on SUN-UNIX-XWindows systems
  67. for a few years, and always have been envious of the nifty "eye candy"
  68. types of programs which are distributed with these systems
  69. As the Amiga platform is now capable of supporting higher screen resolutions
  70. and number of colors (A1200/A4000), the Amiga is finally at the point where
  71. a true "desktop" type of environment is becoming feasible (as opposed to
  72. each and every application opening their own screen)
  73. Worm is my attempt to provide an initial "desktop" environment "eye candy"
  74. program for the Amiga
  75. Note that all the internal workings of Worm are a direct copy of Chuck
  76. McManis's Worm program (FF Disk #218)
  77. I will take credit for the User Interface design/implementation, as well
  78. as the addition of the "Speed" control, as none of these are present in
  79. Mr. McManis's original Amiga version
  80. @endnode
  81. @node gettingstarted "Getting started with Worm"
  82. Just click on the Worm icon.  Worm will detect the number of colors
  83. available on the default Public Screen, and open it's window on this screen
  84. After the window open, select the "Go" item in the Controls menu to start
  85. the worms a-movin
  86. Note that the Workbench screen is the standard default Public Screen
  87. @endnode
  88. @node explanation "Explanation of the Worm menus"
  89. Worm is controlled via selections from it's menus
  90. There are also "Right Amiga key" equivalents for many menu items
  91. The five Worm menus are: Control, Width, Number, Length, and Speed
  92.         @{"Control menu" beep 0}
  93.         Go               - Starts the display of worms based upon the
  94.     (Right Amiga-g)    worm length (Length menu), worm width 
  95.                            (Width menu), and number of worm (Number
  96.                            menu)
  97.                        Selecting Go will disable the Length/Width/
  98.                        Number menus.  To change these parameters,
  99.                            select Stop, change what you wish to, and
  100.                            select Go again
  101.                            The worm speed control (Speed menu) is active
  102.                            at all times
  103.     Stop             - Freezes the display of worms, and allows you 
  104.         (Right Amiga-s)    to alter the three types of physical worm
  105.                        characteristics via the Length/Width/Number 
  106.                        menus
  107.                        "Stop" ALLOWS YOU TO LEAVE WORM UP AND 
  108.                            RUNNING WHILE YOU DO OTHER CPU "CRUNCHING"
  109.                            TYPES OF THINGS!  See follow two UPPER CASE
  110.                            notes for more ideas on minimizing CPU load
  111.     Quit             - Quits the program.  You can also quit by
  112.         (Right Amiga-q)    clicking the close button on the Worm window
  113.     About            - Brings up an info requester
  114.         @{"Width menu" beep 0}
  115.     Controls the worm width (all worms)
  116.         @{"Number menu" beep 0}
  117.     Controls the total number of worms
  118.     NOTE THAT A LOWER NUMBER OF WORMS WILL MINIMIZE THE CPU TIME 
  119.         THAT WORM UTILIZES!
  120.         @{"Length menu" beep 0}
  121.     Controls the worm length (all worms)
  122.         @{"Speed menu" beep 0}
  123.     Controls the speed of the worm movement (Right Amiga-1/9)
  124.     Range is 1 (slowest) to 9 (fastest)
  125.     NOTE THAT A LOWER SPEED VALUE WILL MINIMIZE THE CPU TIME 
  126.         THAT WORM UTILIZES!
  127. @endnode
  128. @node icon "Icon Tooltypes"
  129. Worm recognizes the following Tooltypes within it's icon:
  130.    X=<number>        -    The X-coordinate at which the Worm
  131.                           window will initially open
  132.    Y=<number>        -    The Y-coordinate at which the Worm
  133.                           window will initially open
  134.    WIDTH=<number>    -    The width (in pixels) of the Worm window
  135.                           when it initially opens
  136.    HEIGHT=<number>   -    The height (in pixels) of the Worm window
  137.                           when it initially opens
  138. @endnode
  139. @node credits "Credits"
  140. The GUI for Worm was developed using Jan van den Baards'
  141. wonderful GadToolsBox
  142. Thanks to the KreuzerSoft support team
  143. Thanks to the Nations Capital Amiga Users Group (NCUAG)
  144. Major thanks to Dave at Buried Treasure in Rockville, MD
  145. *********************************************************************
  146. ** Please patronize your local Amiga dealers (like Dave), everyone **
  147. **                                                                 **
  148. ** Most of these people are NOT making tons of $$$$, so if you'd   **
  149. ** like to keep a local presence in your area, GO BUY SOMETHING!   **
  150. *********************************************************************
  151. Thanks to Commodore for the Amiga, and to Jan van den Baard for making
  152. the development of GUI's on the Amiga child's play
  153. Special thanks to Dr. LoPresti and Bruce Forbes (BArF) for their
  154. "C" expertise!
  155. Thanks to Randy Thompson and Rhett Anderson for "Mapping the Amiga/
  156. Second Edition".  Finally, some type of 3.0 "C" book!
  157. @endnode
  158. @node contactingtheauthor "Contacting the Author"
  159. I'd really like to hear any feedback you have regarding Worm
  160. I can be reached via any of the following methods:
  161.    - tkreuzer@delphi.com on the Internet
  162.    - T.KREUZER on GEnie
  163.    - via regular mail at: 6711A N. Washington Blvd.
  164.                           Arlington, VA  22213
  165. @endnode
  166. @node legalstuff "Legal Stuff"
  167. Worm Version 1.1a
  168. Copyright 
  169. 1994 by Timothy B. Kreuzer.  All rights reserved
  170. You are hereby granted the freedom to distribute Worm IF, AND ONLY
  171. IF the following rules are followed:
  172.         - This doc file MUST be kept with the executable(s), and must
  173.           include the above copyright notice
  174.         - You may NOT charge ANY fee for this program, other than the basic
  175.           cost of distribution media and/or BBS access.  Of course if
  176.           you want to pursue selling this, feel free drop me a line
  177. Fred Fish is hereby granted permission to include this program (and it's
  178. accompanying documentation) in his excellent collection of Amiga software
  179. @endnode
  180. @node kreuzersoftproducts "KreuzerSoft Products"
  181. The following KreuzerSoft projects are (hopefully) available on a BBS
  182. near you:
  183.         PST V1.0a          - Public Screen utility for 3.0/AGA
  184.         PaletteTool V1.4   - Public Screen palette program for 3.0/AGA
  185.         Fractal V1.3       - Mandelbrot set program for 3.0/AGA
  186.         LyapunovSpace V1.2 - Lyapunov fractal program for 3.0/AGA
  187.         Terrain V1.1       - 3-D fractal terrain program for 3.0/AGA
  188.         FindColor V1.0a    - "Color-by-Name" selector for 3.0/AGA
  189.         DLA                - Diffusion Limited Aggregation simulation for
  190.                              all Amigas
  191.         Jimi               - 8-color Jimi Hendrix image for your Workbench.
  192.         MemTool            - Memory monitor tool for the Workbench
  193.                                                                      
  194.         Reminder V1.1      - Timed reminder tool for the Workbench
  195. All for the incredibly low, low price of FREE!
  196. @endnode
  197.